<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta content="en" name="language">
	<title>deprecate</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
	<link media="screen" href="../docutils-api.css" type="text/css" rel="stylesheet">

</head>

<body>

<div class="banner">
<img src="../images/gm-107x76.png" alt="GraphicMagick logo" width="107" height="76" />
<span class="title">GraphicsMagick</span>
<form action="http://www.google.com/search">
  <input type="hidden" name="domains" value="www.graphicsmagick.org" />
  <input type="hidden" name="sitesearch" value="www.graphicsmagick.org" />
<span class="nowrap"><input type="text" name="q" size="25" maxlength="255" />&nbsp;<input type="submit" name="sa" value="Search" /></span>
</form>
</div>


<div class="navmenu">
<ul>
  <li><a href="../index.html">Home</a></li>
  <li><a href="../project.html">Project</a></li>
  <li><a href="../download.html">Download</a></li>
  <li><a href="../README.html">Install</a></li>
  <li><a href="../Hg.html">Source</a></li>
  <li><a href="../NEWS.html">News</a> </li>
  <li><a href="../utilities.html">Utilities</a></li>
  <li><a href="../programming.html">Programming</a></li>
  <li><a href="../reference.html">Reference</a></li>
</ul>
</div>

<main id="deprecate">
<h1 class="title">deprecate</h1>
<p class="subtitle" id="methods-which-should-no-longer-be-used">Methods which should no longer be used</p>
<div class="contents topic" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#acquirecacheview" id="id21">AcquireCacheView</a></p></li>
<li><p><a class="reference internal" href="#acquirememory" id="id22">AcquireMemory</a></p></li>
<li><p><a class="reference internal" href="#clonememory" id="id23">CloneMemory</a></p></li>
<li><p><a class="reference internal" href="#getcacheview" id="id24">GetCacheView</a></p></li>
<li><p><a class="reference internal" href="#liberatememory" id="id25">LiberateMemory</a></p></li>
<li><p><a class="reference internal" href="#popimagepixels" id="id26">PopImagePixels</a></p></li>
<li><p><a class="reference internal" href="#pushimagepixels" id="id27">PushImagePixels</a></p></li>
<li><p><a class="reference internal" href="#reacquirememory" id="id28">ReacquireMemory</a></p></li>
<li><p><a class="reference internal" href="#setcacheview" id="id29">SetCacheView</a></p></li>
<li><p><a class="reference internal" href="#synccacheview" id="id30">SyncCacheView</a></p></li>
<li><p><a class="reference internal" href="#strip" id="id31">Strip</a></p></li>
</ul>
</div>
<section id="acquirecacheview">
<h1><a class="toc-backref" href="#id21">AcquireCacheView</a></h1>
<section id="synopsis">
<h2>Synopsis</h2>
<pre class="literal-block">const <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AcquireCacheView( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y,
                                     const unsigned long columns, const unsigned long rows,
                                     <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
</section>
<section id="description">
<h2>Description</h2>
<p>Method AcquireCacheView gets pixels from the in-memory or disk pixel cache
as defined by the geometry parameters for read-only access.   A pointer to
the pixels is returned if the pixels are transferred, otherwise NULL is
returned.</p>
<p>The format of the AcquireCacheView method is:</p>
<pre class="literal-block">const <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AcquireCacheView( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y,
                                     const unsigned long columns, const unsigned long rows,
                                     <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
<dl class="simple">
<dt>pixels:</dt>
<dd><p>Method AcquireCacheView returns a null pointer if an error
occurs, otherwise a pointer to the view pixels.</p>
</dd>
<dt>view:</dt>
<dd><p>The address of a structure of type ViewInfo.</p>
</dd>
<dt>x,y,columns,rows:</dt>
<dd><p>These values define the perimeter of a region of
pixels.</p>
</dd>
<dt>exception:</dt>
<dd><p>Return any errors or warnings in this structure.</p>
</dd>
</dl>
</section>
</section>
<section id="acquirememory">
<h1><a class="toc-backref" href="#id22">AcquireMemory</a></h1>
<section id="id1">
<h2>Synopsis</h2>
<pre class="literal-block">void *AcquireMemory( const size_t size );</pre>
</section>
<section id="id2">
<h2>Description</h2>
<p>AcquireMemory() returns a pointer to a block of memory of at least size
bytes suitably aligned for any use.  NULL is returned if insufficient
memory is available or the requested size is zero.</p>
<p>The format of the AcquireMemory method is:</p>
<pre class="literal-block">void *AcquireMemory( const size_t size );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>size:</dt>
<dd><p>The size of the memory in bytes to allocate.</p>
</dd>
</dl>
</section>
</section>
<section id="clonememory">
<h1><a class="toc-backref" href="#id23">CloneMemory</a></h1>
<section id="id3">
<h2>Synopsis</h2>
<pre class="literal-block">void *CloneMemory( void *destination, const void *source, const size_t size );</pre>
</section>
<section id="id4">
<h2>Description</h2>
<p>CloneMemory() copies size bytes from memory area source to the
destination.  Copying between objects that overlap will take place
correctly.  It returns destination.</p>
<p>The format of the CloneMemory method is:</p>
<pre class="literal-block">void *CloneMemory( void *destination, const void *source, const size_t size );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>size:</dt>
<dd><p>The size of the memory in bytes to allocate.</p>
</dd>
</dl>
</section>
</section>
<section id="getcacheview">
<h1><a class="toc-backref" href="#id24">GetCacheView</a></h1>
<section id="id5">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetCacheView( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y,
                           const unsigned long columns, const unsigned long rows );</pre>
</section>
<section id="id6">
<h2>Description</h2>
<p>GetCacheView() gets writeable pixels from the in-memory or disk pixel
cache as defined by the geometry parameters.   A pointer to the pixels
is returned if the pixels are transferred, otherwise a NULL is returned.</p>
<p>The format of the GetCacheView method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetCacheView( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y,
                           const unsigned long columns, const unsigned long rows );</pre>
<dl class="simple">
<dt>pixels:</dt>
<dd><p>Method GetCacheView returns a null pointer if an error
occurs, otherwise a pointer to the view pixels.</p>
</dd>
<dt>view:</dt>
<dd><p>The address of a structure of type ViewInfo.</p>
</dd>
<dt>x,y,columns,rows:</dt>
<dd><p>These values define the perimeter of a region of
pixels.</p>
</dd>
</dl>
</section>
</section>
<section id="liberatememory">
<h1><a class="toc-backref" href="#id25">LiberateMemory</a></h1>
<section id="id7">
<h2>Synopsis</h2>
<pre class="literal-block">void LiberateMemory( void ** memory );</pre>
</section>
<section id="id8">
<h2>Description</h2>
<p>LiberateMemory() frees memory that has already been allocated, and
NULLs the pointer to it.</p>
<p>The format of the LiberateMemory method is:</p>
<pre class="literal-block">void LiberateMemory( void ** memory );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>memory:</dt>
<dd><p>A pointer to a block of memory to free for reuse.</p>
</dd>
</dl>
</section>
</section>
<section id="popimagepixels">
<h1><a class="toc-backref" href="#id26">PopImagePixels</a></h1>
<section id="id9">
<h2>Synopsis</h2>
<pre class="literal-block">unsigned int PopImagePixels( const <a class="reference external" href="../api/types.html#image">Image</a> *, const <a class="reference external" href="../api/types.html#quantumtype">QuantumType</a> quantum,
                             unsigned char *destination );</pre>
</section>
<section id="id10">
<h2>Description</h2>
<p>PopImagePixels() transfers one or more pixel components from the image pixel
cache to a user supplied buffer.   True is returned if the pixels are
successfully transferred, otherwise False.</p>
<p>The format of the PopImagePixels method is:</p>
<pre class="literal-block">unsigned int PopImagePixels( const <a class="reference external" href="../api/types.html#image">Image</a> *, const <a class="reference external" href="../api/types.html#quantumtype">QuantumType</a> quantum,
                             unsigned char *destination );</pre>
<dl class="simple">
<dt>status:</dt>
<dd><p>Method PopImagePixels returns True if the pixels are
successfully transferred, otherwise False.</p>
</dd>
<dt>image:</dt>
<dd><p>The image.</p>
</dd>
<dt>quantum:</dt>
<dd><p>Declare which pixel components to transfer (RGB, RGBA, etc).</p>
</dd>
<dt>destination:</dt>
<dd><p>The components are transferred to this buffer.</p>
</dd>
</dl>
</section>
</section>
<section id="pushimagepixels">
<h1><a class="toc-backref" href="#id27">PushImagePixels</a></h1>
<section id="id11">
<h2>Synopsis</h2>
<pre class="literal-block">unsigned int PushImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#quantumtype">QuantumType</a> quantum_type,
                              const unsigned char *source );</pre>
</section>
<section id="id12">
<h2>Description</h2>
<p>PushImagePixels() transfers one or more pixel components from a user
supplied buffer into the image pixel cache of an image.  It returns True if
the pixels are successfully transferred, otherwise False.</p>
<p>The format of the PushImagePixels method is:</p>
<pre class="literal-block">unsigned int PushImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#quantumtype">QuantumType</a> quantum_type,
                              const unsigned char *source );</pre>
<dl class="simple">
<dt>status:</dt>
<dd><p>Method PushImagePixels returns True if the pixels are
successfully transferred, otherwise False.</p>
</dd>
<dt>image:</dt>
<dd><p>The image.</p>
</dd>
<dt>quantum_type:</dt>
<dd><p>Declare which pixel components to transfer (red, green,
blue, opacity, RGB, or RGBA).</p>
</dd>
<dt>source:</dt>
<dd><p>The pixel components are transferred from this buffer.</p>
</dd>
</dl>
</section>
</section>
<section id="reacquirememory">
<h1><a class="toc-backref" href="#id28">ReacquireMemory</a></h1>
<section id="id13">
<h2>Synopsis</h2>
<pre class="literal-block">void ReacquireMemory( void ** memory, const size_t size );</pre>
</section>
<section id="id14">
<h2>Description</h2>
<p>ReacquireMemory() changes the size of the memory and returns a
pointer to the (possibly moved) block.  The contents will be unchanged
up to the lesser of the new and old sizes.</p>
<p>The format of the ReacquireMemory method is:</p>
<pre class="literal-block">void ReacquireMemory( void ** memory, const size_t size );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>memory:</dt>
<dd><p>A pointer to a memory allocation.  On return the pointer
may change but the contents of the original allocation will not.</p>
</dd>
<dt>size:</dt>
<dd><p>The new size of the allocated memory.</p>
</dd>
</dl>
</section>
</section>
<section id="setcacheview">
<h1><a class="toc-backref" href="#id29">SetCacheView</a></h1>
<section id="id15">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *SetCacheView( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y,
                           const unsigned long columns, const unsigned long rows );</pre>
</section>
<section id="id16">
<h2>Description</h2>
<p>SetCacheView() gets pixels from the in-memory or disk pixel cache as
defined by the geometry parameters.   A pointer to the pixels is returned
if the pixels are transferred, otherwise a NULL is returned.</p>
<p>The format of the SetCacheView method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *SetCacheView( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y,
                           const unsigned long columns, const unsigned long rows );</pre>
<dl class="simple">
<dt>view:</dt>
<dd><p>The address of a structure of type ViewInfo.</p>
</dd>
<dt>x,y,columns,rows:</dt>
<dd><p>These values define the perimeter of a region of
pixels.</p>
</dd>
</dl>
</section>
</section>
<section id="synccacheview">
<h1><a class="toc-backref" href="#id30">SyncCacheView</a></h1>
<section id="id17">
<h2>Synopsis</h2>
<pre class="literal-block">MagickPassFail SyncCacheView( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view );</pre>
</section>
<section id="id18">
<h2>Description</h2>
<p>SyncCacheView() saves the view pixels to the in-memory or disk cache.
The method returns MagickPass if the pixel region is synced, otherwise
MagickFail.</p>
<p>The format of the SyncCacheView method is:</p>
<pre class="literal-block">MagickPassFail SyncCacheView( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>view:</dt>
<dd><p>The address of a structure of type ViewInfo.</p>
</dd>
</dl>
</section>
</section>
<section id="strip">
<h1><a class="toc-backref" href="#id31">Strip</a></h1>
<section id="id19">
<h2>Synopsis</h2>
<pre class="literal-block">void Strip( char *message );</pre>
</section>
<section id="id20">
<h2>Description</h2>
<p>Method Strip strips any whitespace or quotes from the beginning and end of
a string of characters.</p>
<p>The format of the Strip method is:</p>
<pre class="literal-block">void Strip( char *message );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>message:</dt>
<dd><p>Specifies an array of characters.</p>
</dd>
</dl>
</section>
</section>
</main>


<hr class="docutils">
<div class="document">
    <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002-2025<!--SPONSOR_LOGO--></p>
</div>

</main>
</body>
</html>
